/*
 * Copyright 2017-2025 Lenses.io Ltd
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.lenses.streamreactor.connect.cloud.common.sink.naming

import io.lenses.streamreactor.connect.cloud.common.model.Offset
import io.lenses.streamreactor.connect.cloud.common.model.location.CloudLocation
import io.lenses.streamreactor.connect.cloud.common.sink.SinkError

/**
 * Creates the object key for the cloud storage
 */
trait ObjectKeyBuilder {

  /**
   * Builds the key
   *
   * @param offset                  the offset of the last record
   * @param earliestRecordTimestamp the earliest record timestamp
   * @param latestRecordTimestamp   the latest record timestamp
   * @return the final file name
   */
  def build(
    offset:                  Offset,
    earliestRecordTimestamp: Long,
    latestRecordTimestamp:   Long,
  ): Either[SinkError, CloudLocation]
}
